/*
 * Copyright 2011-2020 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.springframework.data.neo4j.repository.query;

import org.neo4j.ogm.cypher.query.SortOrder;
import org.springframework.data.repository.query.ParameterAccessor;

/**
 * Class used to lookup and handle special parameters such as depth, spatial parameters...
 *
 * @author Nicolas Mervaillie
 */
public interface GraphParameterAccessor extends ParameterAccessor {

	/**
	 * Gets the loading depth value of the {@link org.springframework.data.neo4j.annotation.Depth} annotated method
	 * parameter.
	 *
	 * @return the depth value
	 */
	int getDepth();

	/**
	 * Get OGM specific sort order translated from method parameters.
	 *
	 * @return The sort order
	 */
	SortOrder getOgmSort();

	// Should probably do the same for ogm specific pagination
}
